gh-59330: Improve error message for dest= for positionals #125215
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also improve the documentation. Specify how dest and metavar are derived from add_argument() positional arguments. Co-authored-by: Simon Law <sfllaw@sfllaw.ca>
savannahostrowski
requested changes
Oct 11, 2024
savannahostrowski
approved these changes
Oct 11, 2024
Comment on lines
+639
to
+645
| By default, argparse automatically handles the internal naming and | ||
| display names of arguments, simplifying the process without requiring | ||
| additional configuration. | ||
| As such, you do not need to specify the dest_ and metavar_ parameters. | ||
| The dest_ parameter defaults to the argument name with underscores ``_`` | ||
| replacing hyphens ``-`` . The metavar_ parameter defaults to the | ||
| upper-cased name. For example:: |
There was a problem hiding this comment.
Suggested change
| By default, argparse automatically handles the internal naming and | |
| display names of arguments, simplifying the process without requiring | |
| additional configuration. | |
| As such, you do not need to specify the dest_ and metavar_ parameters. | |
| The dest_ parameter defaults to the argument name with underscores ``_`` | |
| replacing hyphens ``-`` . The metavar_ parameter defaults to the | |
| upper-cased name. For example:: | |
| By default, argparse automatically handles the internal naming and | |
| display names of arguments, simplifying the process without requiring | |
| additional configuration. As such, you do not need to specify the dest_ | |
| and metavar_ parameters. The dest_ parameter defaults to the argument | |
| name with underscores ``_`` replacing hyphens ``-`` . The metavar_ | |
| parameter defaults to the upper-cased name. For example:: |
There was a problem hiding this comment.
Just removing the newline as I think that this can be one short paragraph.
There was a problem hiding this comment.
This does not affect the result. For Sphinx this is the same.
I prefer to start new sentence from a new line. This will help to keep the text more readable in future without reformatting the whole paragraph. Adding or removing will only affect one sentence.
I don't know if this is already in the style guide, but I try to follow this rule.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also improve the documentation. Specify how dest and metavar are derived from add_argument() positional arguments.
📚 Documentation preview 📚: https://cpython-previews--125215.org.readthedocs.build/